Skip to content

docs: Polishing the docs (changelog, _IDK variants, adding new benchmarks)#178

Open
fsschneider wants to merge 8 commits intomainfrom
docs_polish
Open

docs: Polishing the docs (changelog, _IDK variants, adding new benchmarks)#178
fsschneider wants to merge 8 commits intomainfrom
docs_polish

Conversation

@fsschneider
Copy link
Contributor

PR Checklist

  • Use descriptive commit messages.
  • Provide tests for your changes.
  • Update any related documentation and include any relevant screenshots.
  • Check if changes need to be made to docs (README or any guides in /docs/).

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

This PR modifies the documentation in the following way:

  • It removes the lines about changing the Changelog from the PR template, as it is handled automatically.
  • It adds all _IDK variants of the benchmark to the documentation (to be consistent with what we discussed).
  • It extends the guide on how to add new benchmarks with respect to the tests and the documentation

Copy link
Contributor

@prabhuteja12 prabhuteja12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Collaborator

@tfburns tfburns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some nits.

Comment on lines 89 to 90
| Loglikelihood Metrics | Accuracy Loglikelihood |
|| Normalized Accuracy Loglikelihood |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we could add the metrics used by IDK task variants.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed by f0a1184.
@tfburns could you resolve it, if it is satisfactory?


### Testing your benchmark

All tasks automatically go through formatting tests to ensure proper prompt generation. However, if your benchmark has specific functionality that needs testing, create a dedicated test file.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe make a note here that it can be run for individual tasks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed by 5df2fd5.
@tfburns could you resolve it, if it is satisfactory?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants